home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / program / gemxx19.zoo / gem++19 / man / geme.man < prev    next >
Text File  |  1993-07-23  |  3KB  |  90 lines
  1.                      GEM++ - C++ LIBRARIES FOR GEM/AES/VDI
  2.  
  3.  
  4.  
  5. NAME
  6.      GEMevent
  7.  
  8. DESCRIPTION
  9.      A GEMevent is a combination of values that represents and event.
  10.      it also provides the functionality for collecting events from GEM.
  11.  
  12. CONSTRUCTORS
  13.      GEMevent()
  14.        Create an event that holds the button state in effect when
  15.        the event is created.
  16.      GEMevent(int x, int y, int button=0, int clicks=1)
  17.        Creates an event that is a simulated click at the given position
  18.        by the given button the given number of times.
  19.      GEMevent(int key)
  20.        Creates an event that is a simulated key press.
  21.  
  22. METHODS
  23.      void Get(int ev_flags)
  24.        Uses evnt_multi() to get event values - use MU_* constants
  25.        from gemfast.h to define the types of events to accept.
  26.  
  27.      void Interval(int i)
  28.      int Interval()
  29.        Set/get the interval for a timer event.
  30.  
  31.      bool Keyboard()
  32.      bool Button()
  33.      bool Rectange1()
  34.      bool Rectange2()
  35.      bool Rectangle()
  36.      bool Message()
  37.      bool Timer()
  38.        Test the type of event.  Note that a GEMevent may represent
  39.        multiple events.  Normally, an event consumer will ignore these
  40.        methods, as GEMactivity only calls consumers if the event is
  41.        appropriate.
  42.  
  43.      int X()
  44.      int Y()
  45.        Mouse (x,y) position when the event occurred.
  46.  
  47.      int Message(int i)
  48.        Return the given component of a Message event.
  49.  
  50.      int Button(int b)
  51.        Return the state of the given button when the event occurred.
  52.  
  53.      int Clicks()
  54.        Returns the number of mouse clicks that caused the event.
  55.  
  56.      int Meta()
  57.        Returns the state of the metakeys (Shifts, Alt, Control, CAPS)
  58.        when the event occurred.
  59.  
  60.      int Key()
  61.        Returns the key of a key event (NOTE:  Do not confuse this
  62.        with the Keyboard() predicate methods above).
  63.  
  64.      void Button(int mask, int state, bool not=FALSE)
  65.      void Rectangle1(int x, int y, int w, int h, bool out_not_in)
  66.      void Rectangle2(int x, int y, int w, int h, bool out_not_in)
  67.      void Rectangle(int x, int y, int w, int h, bool out_not_in, int R=1)
  68.        Set parameters of the event to Get.
  69.  
  70. SEE ALSO
  71.      GEMactivity, GEMfeedback
  72.  
  73. BUGS
  74.      Bugs in GEM++ should be reported to warwick@cs.uq.oz.au
  75.  
  76. AUTHOR
  77.      Warwick Allison, 1993.
  78.      warwick@cs.uq.oz.au
  79.  
  80. COPYING
  81.      This functionality is part of the GEM++ library,
  82.      and is Copyright 1993 by Warwick W. Allison.
  83.  
  84.      GEM++ is free and protected under the GNU Library General Public
  85.      License.
  86.  
  87.      You are free to copy and modify these sources, provided you
  88.      acknowledge the origin by retaining this notice, and adhere to
  89.      the conditions described in the GNU LGPL.
  90.